1. Overview
To be a valid input into the mapping the application schema should conform to ISO 19109:2005, and GML 3.2 (ISO 19136) Annex E, GML 3.3 and/or ISO/TS 19139.
In addition, extensions to these latter specifications are supported, too, but must be activated in extended encoding rules; see here for details.
1.1. Stereotypes
Well-known stereotypes for the purposes of ShapeChange are those defined in the UML specification, and in the ISO 19100-series of specifications, specifically ISO/TS 19103:2005, ISO 19109:2005 and GML 3.2/ISO 19136:2007.
Stereotypes are not case-sensitive. The stereotypes used in the ISO 19100 standards usually start with a upper case letter, but today the common practice is to start with a lower case letter and avoid whitespace.
Standard aliases listed for a stereotype can be used, too. Aliases can be configured.
All stereotypes not listed below are ignored.
There is one additional stereotype, that can be applied to all model elements, <<retired>>. It can be used in UML models to indicate that a model element has been retired and is only left in the model for compatibility with previous versions of the model. The stereotype currently does not have any impact on the standard ShapeChange output targets.
In UML 1, only one stereotype per model element are supported. UML 2 introduced the capability of model elements to carry more than one stereotype.
1.1.1. Stereotypes of packages
The standard case for packages outside of an application schema, and for subpackages of an application schema, is that no stereotype is applied.
| Stereotype | Aliases | Description |
|---|---|---|
<<Application Schema>> |
<<applicationSchema>>, <<requirementsClass>> |
An application schema according to ISO 19109 [ISO 19109]. |
<<bundle>> |
A package that is not an application schema and contains other packages [GSIP]. Usually mapped to no stereotype. |
|
<<leaf>> |
A package that is not an application schema and contains no packages. [ISO/TS 19103]. Usually mapped to no stereotype. |
|
<<schema>> |
A package that should be treated like <<Application Schema>> but does not contain feature types. |
1.1.2. Stereotypes of classes
The standard case for classes is that no stereotype is applied; class instances are plain objects with identity.
The stereotype <<abstract>> is used by some models, but should be avoided. If a class is abstract, this must be indicated using the UML flag for abstractness, not the stereotype. If the stereotype is provided, it is ignored by ShapeChange.
| Stereotype | Aliases | Description | ||||
|---|---|---|---|---|---|---|
<<ADEElement>> |
Feature type in an CityGML Application Domain Extension (ADE) that contains only properties that are generic application extensions. |
|||||
<<AIXMExtension>> |
Type defined in an AIXM extension schema. It extends a specific feature or object type or all feature types usually from the core AIXM schema. |
|||||
<<attributeConcept>> |
An attribute concept in a feature concept dictionary (see ISO 19126). If a feature type classifier has a dependency to an attribute concept classifier and a property of the same name ShapeChange will use the documentation of the concept as the documentation of the property if the documentation of the property is empty. |
|||||
<<BasicType>> |
Marks a so called basic type, which can have a simple representation in one or more target encodings. It usually is a restriction of CharacterString or Number – or a structured version thereof (e.g. "one two three four" – or any other meaningful combination of such types that is supported by a given encoding).
RECOMMENDATION: Avoid using this stereotype in your application schema. In the future, each target that supports the concept of target-specific basic types should categorize classes as such when the target is executed. The JSON Schema target is an example of how this can be done. Either the model structure is analyzed (e.g. inheritance from a type that is mapped to a basic type), or an encoding specific tagged value is used. |
|||||
<<CodeList>> |
<<conceptScheme>> <<vocabulary>> |
A code list. <<conceptScheme>> and <<vocabulary>> have been used to identify collections of enumerated values that may also have relationships like 'narrower'; for encoding purposes these are treated like code lists. |
||||
<<DataType>> |
<<request>> <<response>> |
A structured data type without identity [ISO/TS 19103]. The <<request>> and <<response>> stereotype were originally used in AFIS-ALKIS-ATKIS to distinguish data types for use in messages of services. For all encoding purposes these are treated as data types and are configured as aliases. |
||||
<<Enumeration>> |
An enumeration. |
|||||
<<FachId>> |
OKSTRA feature types where instances may be referenced through symbolic links. See the OKSTRA documentation (in German). |
|||||
<<featureConcept>> |
A feature concept in a feature concept dictionary (see ISO 19126). If a feature type classifier has a dependency to a feature concept classifier of the same name ShapeChange will use the documentation of the concept as the documentation of the feature type if the documentation of the feature type classifier is empty. |
|||||
<<FeatureType>> |
<<feature>> |
A feature type [ISO 19136]. Some schemas have used <<Feature>> so this has been added as an alias. |
||||
<<Interface>> |
A type that is not directly instantiable but is used as an abstract collection of operation attribute and relation signatures. This stereotype should usually not be used in application schemas as <<interface>> classes are on a different conceptual level. In the encoding these will usually be treated as if no stereotype has been set. |
|||||
<<Schluesseltabelle>> |
OKSTRA Schlüsseltabellen. See the OKSTRA documentation (in German). |
|||||
<<Type>> |
A standard class instances are plain objects with identity. In the encoding these will usually be treated as if no stereotype has been set but can be useful when writing UML models (via the UmlModel target) when classes are augmented by profile-specific tagged values. For the purposes of meta-modeling <<Type>> has been deprecated in UML 2 and <<Interface>> should be used instead. |
|||||
<<Union>> |
A structured data type without identity where exactly one of the properties of the type is present in any instance [ISO/TS 19103]. |
|||||
<<valueConcept>> |
A nominal value concept in a feature concept dictionary (see ISO 19126). If an enumeration has a dependency to an value concept classifier and an enumerant of the same name ShapeChange will use the documentation of the concept as the documentation of the enumerant if the documentation of the enumerant is empty. |
1.1.3. Stereotypes of properties
The standard case for properties is that no stereotype is applied.
| Stereotype | Aliases | Description |
|---|---|---|
<<enum>> |
<<enumerationLiteral>> |
Typical stereotype for attribute of a code list or enumeration. Usually mapped to no stereotype but can be useful when writing UML models (via the UmlModel target). |
<<identifier>> |
An attribute with this stereotype is used to uniquely identify class objects. For database models the attribute represents a primary key field. |
|
<<property>> |
Typical stereotype for attribute or association role of a class that is not a code list or enumeration. Usually mapped to no stereotype but can be useful when writing UML models (via the UmlModel target) when properties are augmented by profile-specific tagged values. |
|
<<version>> |
If in an application schema an association role ends at a spatial object type this stereotype denotes that the value of the property is meant to be a specific version of the spatial object not the spatial object in general. [INSPIRE] |
|
<<voidable>> |
If a characteristic of an object is not present |
1.1.4. Stereotypes of dependencies
The standard case for dependencies is that no stereotype is applied. For package dependencies without a stereotype,<<import>> is implied (source: ISO 19136:2007, section E.2.1.1.1).
| Stereotype | Aliases | Description |
|---|---|---|
<<import>> |
The model elements of the supplier package are imported. |
|
Note
|
ShapeChange stores package dependencies without stereotypes. In other words, stereotypes on package dependencies are ignored (thus, it does not matter if such a dependency has the stereotype <<import>>, <<include>>, or any other stereotype). ShapeChange determines if an application schema has a dependency on a different application schema by examining the target namespaces of both packages; if they are different, the two packages belong to different application schema - otherwise, they belong to the same schema. |
1.1.5. Stereotypes of generalizations
The standard case for generalizations is that no stereotype is applied. ShapeChange ignores stereotypes on generalizations.
| Stereotype | Aliases | Description |
|---|---|---|
<<disjoint>> |
The constraint added to a set of generalization relationships indicates that an instance of the parent may be an instance of one and only one of the children within the set. This is implicitly assumed to be the case. |
1.2. Tagged Values
Tagged values are used to represent additional information in the UML model that are either specific to an encoding or which require a name-value-pair.
The following table documents the tagged values that ShapeChange directly supports, i.e. loads from a model without having to be added via the input parameters addTaggedValues or representTaggedValues.
| Tagged Value | Scope (to which model element(s) does the tag typically apply) | Stereotype (if specific) | Source | Description | ShapeChange Process (if specific) | Links |
|---|---|---|---|---|---|---|
AAA:AAAVersion |
package |
applicationSchema, no stereotype |
GeoInfoDok, German Surveying Agencies |
Version des AAA Schemas von dem das Fachschema abhängt; ggfs. nicht mehr in Verwendung. |
||
AAA:Datum |
package |
applicationSchema, no stereotype |
GeoInfoDok, German Surveying Agencies |
Datum der Version (siehe AAA:Version); für Ableitung von Objektartenkatalogen |
||
AAA:Grunddatenbestand |
class, property |
featureType, type, dataType, union, enumeration, codeList |
GeoInfoDok, German Surveying Agencies |
Kommagetrennte Liste der Modellarten bei denen die Objektart Teil des Grunddatenbestands ist. |
||
AAA:Kennung |
all |
GeoInfoDok, German Surveying Agencies |
Übergreifende Funktion für verschiedene Ableitungen (z.B. DB Schema und Objektartenkataloge). 5-stellig für Klassen, 3-stellig für Eigenschaften (Ausnahmen sind möglich). |
|||
AAA:LetzteAenderung |
class, property |
featureType, type, dataType, union, enumeration, codeList |
GeoInfoDok, German Surveying Agencies |
Datum und Kommentar der letzten Änderung am Element |
||
AAA:Modellart |
all |
GeoInfoDok, German Surveying Agencies |
Dient der Zuordnung eines Modellelements zu einem oder mehreren Modellen. Der Wert entspricht einem Code aus AA_AdVStandardModell oder AA_WeitereModellart. |
|||
AAA:Nutzungsart |
class |
featureType, type, dataType, union, enumeration, codeList |
GeoInfoDok, German Surveying Agencies |
Angaben für den Nutzungsartenkatalog (AdV intern); für Fachschema nicht relevant |
||
AAA:Nutzungsartkennung |
class, property |
featureType, type, dataType, union, enumeration, codeList |
GeoInfoDok, German Surveying Agencies |
Angaben für den Nutzungsartenkatalog (AdV intern); für Fachschema nicht relevant |
||
AAA:objektbildend |
property |
no stereotype |
GeoInfoDok, German Surveying Agencies |
Kommagetrennte Liste der Modellarten bei denen die Eigenschaft objektbildend ist relevant falls Versionierung bei Datenhaltung angewandt werden soll. |
||
AAA:Organisation |
package, applicationSchema |
no stereotype |
GeoInfoDok, German Surveying Agencies |
Name der für das Anwendungsschema verantwortlichen Organisation; für Ableitung von Objektartenkatalogen |
||
AAA:Profile |
class, property |
featureType, type, dataType, union, enumeration, codeList |
GeoInfoDok, German Surveying Agencies |
Kommagetrennte Liste der Profile zu denen die Objektart gehört |
||
AAA:Revisionsnummer |
all |
GeoInfoDok, German Surveying Agencies |
Die genaue Regelung ist bislang nicht dokumentiert. |
|||
AAA:Themen |
class |
featureType, type, dataType, union, enumeration, codeList |
GeoInfoDok, German Surveying Agencies |
Themen zu denen die Objektart gehört (siehe Dokumentation AX_Themendefinition im AAA Anwendungsschema). Anwendbar falls Topologie wichtig ist (die Klasse ist dementsprechend aus AG_ObjektMitGemeinsamerGeometrie abzuleiten). |
||
AAA:Version |
package, applicationSchema |
no stereotype |
GeoInfoDok, German Surveying Agencies |
Version des Schemas |
||
alias |
all |
An alias of the name of the model element usually for presentation to a human. |
||||
allowedTypesNAS |
property |
no stereotype |
GeoInfoDok, German Surveying Agencies |
|||
alwaysVoid |
class |
Identifies properties that are always void for documentation in a feature catalogue (as textual constraint) |
FeatureCatalogue target |
|||
appliesTo |
class |
Identifies network elements to which the class applies for documentation in a feature catalogue (as textual constraint). |
FeatureCatalogue target |
|||
arcgisDefaultSubtype |
property |
Integer code of the ArcGIS subtype that shall be used as default. |
ArcGISWorkspace target |
|||
arcgisSubtypeCode |
class, property |
Relevant for defining subtype codes if ArcGIS subtypes are defined by a code list of enumeration and if ArcGIS subtypes are explicitly modelled |
ArcGISWorkspace target |
|||
arcgisSubtypeInitialValues |
property |
Used to define default values for ArcGIS subtypes defined by a code list of enumeration. |
ArcGISWorkspace target |
|||
arcgisUsedBySubtypes |
property |
Used to identify the subtypes to which an enum or code applies. Relevant for ArcGIS subtype defined by a code list or enumeration. |
ArcGISWorkspace target |
|||
asDictionary |
class |
codeList |
ISO 19136, GML 3.3 |
If the value is 'false' the code list will be encoded with the pre-defined enumerants as values in the schema if 'true' all enumerants will only be maintained in external dictionaries. The default depends on the encoding rule used. |
||
associativeTable |
association, attribute |
Provides the name of the associative table created for an n:m relationship between types. |
SQL target |
|||
asXMLAttribute |
property |
Alias to 'xsdAsAttribute' |
XML Schema target |
|||
base |
class |
Defines the value of \base\ when creating an anonymous basic type for the class. |
XML Schema target |
|||
broaderListedValue |
property |
Used to establish skos:broader relationships between codes. |
Ontology target |
|||
byValuePropertyType |
class |
no stereotype, featureType, type |
ISO 19136 |
Create a property type that requires that the instance is encoded inline. Should usually be set to false. |
||
codeList |
class |
codeList |
The URI of a resource representing the code list for example a code list dictionary. |
FeatureCatalogue target, GML codelist dictionary target, XML Schema target, ldproxy target |
feature catalogue parameter
includeCodeListURI |
|
codeListRepresentation |
class |
codeList |
Define the representation of a code list. Relevant for deriving Schematron constraints. Allowed values are defined by the relevant conversion rules. |
XML Schema target |
rule-xsd-cls-codelist-constraints rule-xsd-cls-codelist-constraints2 |
|
codeListRestriction |
property |
codeList |
Primarily used in metadata profiles to restrict the type of a property (in metadata profiles typically typed CharacterString) to a specific code list (identified by name via the tagged value). The XML Schema target can then generate Schematron assertions that check the restriction. NOTE The tagged value can also be derived from OCL constraints via the ConstraintConverter transformation (rule-trf-cls-constraints-codeListRestrictionToTV). |
ConstraintConverter, XML Schema target |
rule-trf-cls-constraints-codeListRestrictionToTV rule-xsd-cls-codelist-constraints2 |
|
codeListSource |
class |
codeList |
Provides a link to a remote or local resource (in a specific representation defined by tagged value codeListSourceRepresentation) which contains the currently defined code for a code list. Can be used to load the codes from that source into the model for example to derive Schematron constraints. |
Code List Loader transformation |
||
codeListSourceCharset |
class |
codeList |
Defines the character set of the resource referenced by tagged value codeListSource. |
Code List Loader transformation |
||
codeListSourceRepresentation |
class |
codeList |
Identifies the type of resource referenced by tagged value codeListSource. For example application/x.iso639_2. |
Code List Loader transformation |
||
codelistType |
class |
codeList |
Defines application-specific category for a code list. This information can be used by the SQL target to separate code insert statements produced by the target by code list type. |
SQL target |
SqlDdl parameter separateCodeInsertStatementsByCodelistType |
|
codeListValuePattern |
class |
codeList |
Value access pattern for the code list containing the substitution points {codeList} and {value}, where {codeList} is the base URI of the code list (replaced by the tagged value codeList and {value} the local identifier of the code list value. Default \{codeList}/{value}\ |
XML Schema target |
||
dataCaptureStatement |
all |
A statement describing how to capture instances of the model element from the real-world. |
||||
defaultCodeSpace |
class |
codeList |
ISO 19136 |
The URI of the default dictionary that contains code list. |
||
defaultGeometry |
property |
OGC UGAS-2020 Engineering Report |
When set to true, it identifies the geometry property that serves as default geometry. |
JSON Schema target |
||
definition |
all |
The normative specification of the model element. Using this tag is one approach to defining the source of descriptor 'definition'. |
||||
description |
all |
Additional informative information about the model element. Using this tag is one approach to defining the source of descriptor 'description'. |
||||
dissolveAssociation |
association |
If set to 'false' the association will be excluded from the TypeConverter transformation rule-trf-dissolveAssociations. |
TypeConverter transformation |
|||
dissolveAssociationAttributeType |
association role |
Can be used to define the type of the attribute which results from transforming the association role using the TypeConverter transformation rule-trf-dissolveAssociations. |
TypeConverter transformation |
|||
documentation |
all |
UML |
The documentation for the model element. Using this tag is one approach to defining the source of descriptor 'documentation'. |
|||
example |
all |
An example illustrating the model element. |
||||
extensibility |
class |
codeList |
INSPRIE |
This refers to extensions by a third party not to extensions by the owner of the vocabulary; the owner will always be able to revise the vocabulary. I.e. if the value is 'none' the referenced vocabulary may not be extended by third parties; if the value is 'narrower' the vocabulary may be extended by narrower terms that have an existing term as a parent; if the value is 'any' the vocabulary may be extended by additional terms on any level. This value must be 'any' empty or missing if the value 'vocabulary' is empty or missing; in this case any vocabulary may be used. |
Requirements for classes (see req-xsd-cls-codelist-extensibility-values and req-xsd-cls-codelist-extensibility-vocabulary) |
|
fieldType |
class |
codeList, enumeration |
Define the ESRI field type for properties that have the code list or enumeration as type. Overrides tagged value 'numericType'. |
ArcGISWorkspace target |
Creating the ArcGIS Workspace UML Model - Conversion of model elements - Class |
|
formcols |
property |
Used in creating an application configuration file (via the as yet undocumented AppConfiguration target). |
AppConfiguration target (undocumented) |
|||
formrows |
property |
Used in creating an application configuration file (via the as yet undocumented AppConfiguration target). |
AppConfiguration target (undocumented) |
|||
generationDateTime |
package |
Date and time that the application schema was generated for documentation in feature catalogues (currently only frame-based HTML feature catalogues). |
FeatureCatalogue target |
|||
geometry |
class |
Identifies the geometry types allowed for this class if it is flattened to classes with homogeneous geometry. For further details, see Flattener transformation rule-trf-prop-flatten-homogeneousgeometries. (Comma-separated) Value(so must match @param value(s) of map entries with @rule=rule-trf-prop-flatten-homogeneousgeometries from the Flattener configuration. Example: P, C. |
Flattener transformation |
rule-trf-prop-flatten-homogeneousgeometries |
||
gmlArrayProperty |
property |
For properties with a tagged value gmlArrayProperty set to true and with complex content that is always inline i.e. the property has the tagged value inlineOrByReference set to inline an array property is created instead of using the standard GML property types. |
XML Schema target |
|||
gmlAsCharacterString |
class |
union |
A union with a tagged value gmlAsCharacterString set to true is not converted in the usual way but converted as if it would be a CharacterString. |
XML Schema target |
||
gmlAsGroup |
class |
union |
A union class with tagged value gmlAsGroup = true is encoded as a global group which is referenced wherever a property is defined that has the union class as its value. (Note that this is only valid if it is clear from the context how to map the individual values to the conceptual model.) |
XML Schema target |
||
gmlImplementedByNilReason |
property |
Primarily used by the XML Schema target, see descriptions of rule-xsd-prop-nilReasonAllowed and rule-xsd-cls-union-direct. Also used by the SQL target to determine if a column can be NULL. |
XML Schema target |
rule-xsd-cls-union-direct |
||
gmlListProperty |
property |
For properties with a tagged value gmlListProperty set to true and with a simple type as value, maxOccurs is suppressed and a list type is created. |
XML Schema target |
|||
gmlMixin |
class |
no stereotype, type, featureType |
Identifies the type as a mixin type that will not be encoded as a separate element/type in the XML encoding but properties will be copied to subtypes. This is a ShapeChange extension which supports multiple inheritance for application schema types in specific cases. |
|||
gmlProfileSchema |
package |
applicationSchema |
ISO 19136 |
URL of the schema location of a GML profile (where applicable). |
XML Schema target |
|
gpkgM |
property (with geometry type) |
Define whether m values are prohibited (value: 0), mandatory (value: 1), or optional (value: 2) on the geometric column that represents the UML property. |
GeoPackage Template target |
|||
gpkgZ |
property (with geometry type) |
Define whether z values are prohibited (value: 0), mandatory (value: 1), or optional (value: 2) on the geometric column that represents the UML property. |
GeoPackage Template target |
|||
HasM |
class |
featureType |
Controls setting of HasM for ArcGIS feature classes. |
ArcGIS Workspace target |
||
HasZ |
class |
featureType |
Controls setting of HasZ for ArcGIS feature classes. |
ArcGIS Workspace target |
||
infoURL |
class |
codeList, enumeration |
Can be used to define the @codeSpace of gml:identifiers of dictionary content. |
Codelist Dictionary targets |
||
inlineOrByReference |
property |
ISO 19136 |
Controls whether property values may be encoded inline or by reference. Valid values are 'inline', 'byReference' and 'inlineOrByReference'. Default is 'inlineOrByReference'. |
|||
isCollection |
class |
no stereotype, featureType, type |
ISO 19136 |
Identifies the type as a collection. |
||
isFlatTarget |
association role |
Can be used to control how complex type flattening is applied in case of a bi-directional association which is made uni-directional through application of rule-trf-prop-removeNavigabilityBasedOnIsFlatTarget based upon the isFlatTarget setting. |
Flattener transformation |
|||
isMetadata |
property |
ISO 19136 |
Indicates whether the property is considered metadata about the instance and not information about the phenomenon in the real world. 'true' or 'false', the default is 'false'. |
|||
jsonBaseURI |
schema package |
OWS-9 System Security Interoperability (SSI) UML-to-GML-Application-Schema (UGAS) Conversion Engineering Report |
Can be used to define the base of the URI that is used as value of the 'id' field of a JSON Schema file generated by ShapeChange. Takes precedence over the JSON Schema target parameter jsonBaseURI. |
JSON Schema target |
JSON Schema target parameter jsonBaseURI |
|
jsonDirectory |
schema package |
OWS-9 System Security Interoperability (SSI) UML-to-GML-Application-Schema (UGAS) Conversion Engineering Report |
Used to define a subdirectory within the URI that is used as value of the 'id' field of a JSON Schema file generated by ShapeChange. |
JSON Schema target |
JSON Schema target parameter jsonBaseURI |
|
jsonDocument |
package |
OGC UGAS-2020 Engineering Report |
The name of the file (xyz.json) in which the JSON Schema definitions for the classes contained in the package will be encoded. |
JSON Schema target |
||
jsonEncodingRule |
all |
OWS-9 System Security Interoperability (SSI) UML-to-GML-Application-Schema (UGAS) Conversion Engineering Report |
Controls the applicable conversion rule on a model element. Typically this will be set only on the application schema level or provided as external input to the conversion process |
JSON Schema target |
||
jsonFormat |
class |
To define the JSON Schema keyword 'format' for a basic type modelled in the application schema |
JSON Schema target |
|||
jsonLayerTableURI |
class |
featureType |
OWS-9 System Security Interoperability (SSI) UML-to-GML-Application-Schema (UGAS) Conversion Engineering Report |
The URI of the associated Layer/Table resource in a GeoServices REST API Feature Service. This can usually not be set as there will be more then one service that provides information on a feature type. However, if it is provided, explicit \links\ properties as specified by JSON Schema can be provided in the schema of the feature type. |
JSON Schema target |
|
jsonPattern |
class |
To define the JSON Schema keyword 'pattern' for a basic type modelled in the application schema |
JSON Schema target |
|||
jsonPrimaryGeometry |
property |
To identify the primary geometry property of a feature type. |
JSON Schema target |
|||
jsonPrimaryInstant |
property |
To identify the primary instant property of a feature type. |
JSON Schema target |
|||
jsonPrimaryInterval |
property |
To identify the primary interval properties of a feature type. |
JSON Schema target |
|||
jsonPrimaryPlace |
property |
To identify the primary place property of a feature type. |
JSON Schema target |
|||
language |
all |
The default language, if no language information is provided in definitions, descriptions, examples, etc. |
||||
legalBasis |
all |
The legal basis for the model element: |
||||
length |
class, property |
Used to define the maximum length of a string valued attribute. Sometimes also used on classes. |
CDB, XML Schema, and JSON Schema targets |
rule-xsd-cls-basictype |
||
literalEncodingType |
class |
enumeration, codeList |
OGC UGAS-2020 Engineering Report |
Identifies the conceptual type that applies to the enumeration values. |
JSON Schema target |
|
maxExclusive |
class |
Define the maximum range (exclusive) of a (numeric) basic type. |
JSON Schema target |
|||
maxInclusive |
class |
Define the maximum range (inclusive) of a (numeric) basic type. |
JSON Schema target |
|||
maxLength |
class, property |
Used to define the maximum length of a string valued attribute. Sometimes also used on classes. |
XML Schema and JSON Schema targets |
rule-xsd-cls-basictype |
||
maxOccurs |
property |
Used to control how many copies of a property are created while flattening multiplicity. |
Flattener transformation |
|||
metadataType |
property |
propertyMetadata |
UGAS-2019 report |
Identifies the type of the metadata that can be associated with the property (more specifically, its value(s)). |
TypeConverter transformation |
|
minExclusive |
class |
Define the minimum range (exclusive) of a (numeric) basic type. |
JSON Schema target |
|||
minInclusive |
class |
Define the minimum range (inclusive) of a (numeric) basic type. |
JSON Schema target |
|||
minLength |
class |
Define the minimum length of a (string-valued) basic type. |
JSON Schema target |
|||
name |
package, class, property |
Typically used to define an additional name for a model element. Can be used by the (old) OWS-8 ontology target to define the skos:prefLabel of a skos:ConceptScheme. |
Flattener transformation, (old) OWS-8 ontology target |
rule-trf-prop-flatten-types |
||
neverVoid |
class |
Identifies properties that are never void, for documentation in a feature catalogue (as textual constraint). |
FeatureCatalogue target |
|||
nillable |
property |
If set to 'true' on a property, this states that the property is voidable (also called nillable). |
Support for nillable and nilReason |
|||
nilReasonAllowed |
property |
'true', if the nilReason attribute is allowed in the XML encoding of the property. |
XML Schema target |
|||
noncomparableMeasure |
attribute |
Valid non-comparable unit. Example: \flightLevel\ |
||||
noPropertyType |
class |
no stereotype, featureType, type, dataType, union |
ISO 19136 |
Set to 'true' to suppress creation of a standard property type that supports inline or by-reference encoding. For data types only inline encoding is supported. Should usually be set to 'false'. |
XML Schema target |
|
numericType |
class |
codeList, enumeration |
Setting this tagged value on a code list or enumeration indicates that the codes are numeric. The tagged value contains the name of the conceptual type that represents the code values best, for example 'Number' or 'Integer'. |
ArcGISWorkspace and SQL targets |
Creating the ArcGIS Workspace UML Model - conversion of model elements - classes |
|
obligation |
property |
INSPIRE |
The value type of the property must be a code list. The use of the referenced code list may be made legally required in the implementing rule ('implementingRule') or only in the technical guidance ('technicalGuidance'). This value must be empty or missing, if the value 'vocabulary' in the value type is empty or missing. |
|||
oclExpressions |
class |
Used on XMI encoded models, to define OCL expressions of a class. Note that due to a lack of use, the logic for loading of XMI models has not been maintained in ShapeChange for quite some time. |
||||
omitWhenFlattened |
class |
Can be used to control naming of properties while flattening complex types. Primarily set to 'true' on helper classes that aggregate a number of properties which are used by multiple classes (e.g. WaterResourceInfo). Helps reducing the length of names of flattened model elements. This mechanism only works if the maximum multiplicity of properties with the class © that has omitWhenFlattened=true as value type is exactly 1. In addition, classes that own such properties must not contain a property with a name that equals the name of one of the properties from ©. Otherwise the result would be ambiguous. |
Flattener transformation |
|||
oneToManyReferenceColumnName |
class |
datatype |
Can be used to define the name of the additional reference column which is added to the table that represents the data type. |
SQL target |
||
ontologyName |
package |
Can be used to define the name of the ontology that is derived from a package. NOTE: Defining the ontology name by tagged value is useful if ontologies shall be derived from multiple schemas, and each shall have a specific ontology name that is defined in the UML model. |
Ontology target |
|||
owlDisjointProperties |
property |
OGC Testbed-14: Application Schema-based Ontology Development Engineering Report (OGC 18-032r2) - chapter OWL Property Enrichment |
Used to define the OWL property axiom 'disjoint' for the OWL property that represents the UML property with this tagged value. |
Ontology target |
||
owlEquivalentProperties |
property |
OGC Testbed-14: Application Schema-based Ontology Development Engineering Report (OGC 18-032r2) - chapter OWL Property Enrichment |
Used to define the OWL property axiom 'equivalent' for the OWL property that represents the UML property with this tagged value. |
Ontology target |
||
owlInverseProperties |
property |
OGC Testbed-14: Application Schema-based Ontology Development Engineering Report (OGC 18-032r2) - chapter OWL Property Enrichment |
Used to define the OWL property axiom 'inverse' for the OWL property that represents the UML property with this tagged value. |
Ontology target |
||
owlLogicalCharacteristics |
property |
OGC Testbed-14: Application Schema-based Ontology Development Engineering Report (OGC 18-032r2) - chapter OWL Property Enrichment |
Used to define the OWL property axioms 'functional', 'inverse-functional', 'reflexive', 'irreflexive', 'symmetric', 'asymmetric', and 'transitive' for the OWL property that represents the UML property with this tagged value. |
Ontology target |
||
owlSubPropertyOf |
property |
OGC Testbed-14: Application Schema-based Ontology Development Engineering Report (OGC 18-032r2) - chapter OWL Property Enrichment |
Used to define the OWL property axiom 'subPropertyOf' for the OWL property that represents the UML property with this tagged value. |
Ontology target |
||
parent |
property, class |
class (itself, or that owns the property): codeList, enumeration |
OGC Engineering Report OWS-8 Cross Community Interoperability (CCI) Semantic Mediation, OGC document number 11-063r6. See sub-clause 8.1 |
Can be used to define hierarchical code lists (as specified in the IMGeo specification in the Netherlands). |
(old) OWS-8 ontology target |
UML to RDF/OWL target (based on OWS-8 encoding rule) - rule-rdf-prop-parent |
pattern |
property |
Regular expression that constrains the textual value of the property. |
XML Schema target |
rule-xsd-prop-constrainingFacets |
||
physicalQuantity |
attribute |
Physical quantity of the referenced unit. Example: \length\ |
||||
precision |
property, also class (representing a numeric code list [SQL target]) |
Can be used to define the precision for the target representation of the property (or properties with numeric code list). |
ArcGIS Workspace and SQL targets |
|||
primaryCode |
all |
The primary code for the model element. |
||||
profiles |
property, class |
Identifies the profiles to which the model element belongs. |
Profiler transformation, Model Export, Profile Transfer EA, and Application Schema Metadata targets |
Model export target |
||
prohibitedInProfile |
property, class |
Set to 'true' to indicate that the property or the class is prohibited. This can be used to prevent creation of (Schematron) property assertions in rule-xsd-cls-codelist-constraints2. |
XML Schema target, Profile Constraint transformer |
rule-xsd-all-propertyAssertion-ignoreProhibited |
||
rangeMaximum |
property, also class (XML Schema and JSON Schema targets) |
Define the maximum range of the property, or of a basic XML Schema type. |
ArcGIS Workspace, SQL, CDB, XML Schema, and JSON Schema targets |
rule-arcgis-cls-rangeDomainFromTaggedValues |
||
rangeMinimum |
property, also class (XML Schema and JSON Schema targets) |
Define the minimum range of the property, or of a basic XML Schema type. |
ArcGIS Workspace, SQL, CDB, XML Schema, and JSON Schema targets |
rule-sql-cls-check-constraint-for-range |
||
recommendedMeasure |
attribute |
Unit recommended for use with this property. The unit must be consistent with the physicalQuantity value. Example: \metre\ |
||||
Reiter |
property |
Used in creating an application configuration file (via the as yet undocumented, AppConfiguration target). |
AppConfiguration target (undocumented) |
|||
reportable |
property |
Used to define the subsets under which the property is published. |
LD Proxy target |
Ldproxy target parameter enablePropertiesReportable |
||
resourceURI |
property (of an enumeration or code list) |
Used to produce XPath expressions when generating Schematron. If an enum or code (modelled as attribute of an enumeration or code list) has tagged value resourceURI, it is used as literal value during the translation of the enum/code to a literal value within an XPath expression, instead of the enum/code name. |
Targets that generate Schematron |
|||
reverseRoleNAS |
property |
no stereotype |
GeoInfoDok, German Surveying Agencies |
Wert des UML Tagged Value reverseRoleNAS wird im XML Schema in appinfo-Annotationen an dem Element ausgegeben, das der Assoziationsrolle entspricht. Kann bei Modellierung ignoriert werden wenn Historisierung keine Rolle spielt. Wird bei Bedarf automatisch durch NAS-Transformation zu Implementierungsschema gesetzt. |
||
scale |
property, also class (representing a numeric code list [SQL target]) |
Can be used to define the scale for the target representation of the property (or properties with numeric code list). |
ArcGIS Workspace and SQL targets |
|||
sequenceNumber |
property |
ISO 19136 |
Used to sort/order the properties of the class to which the property belongs. The value shall be an integer value that is unique for the properties of that class. |
|||
shortName |
property, class |
Define a short name for a model element, for shortening the names of representations in a given encoding. |
ArcGIS Workspace and SQL targets |
rule-sql-all-constraintNameUsingShortName |
||
size |
property, also class (JSON Schema target) |
Used to define the maximum length of a string valued attribute. Sometimes also used on classes. |
ArcGIS Workspace, SQL, XML Schema and JSON Schema targets |
SqlDdl target - Textual Data Type with Limited or Unlimited Length |
||
skosConceptSchemeSubclassName |
class |
codeList |
Can be used to define the name of the skos:ConceptScheme subclass created for a code list. |
Ontology target |
||
soft-typed |
property |
Set to 'true' in order for the property to be encoded in XML with an additional 'name' attribute. Used in the SWE Common Data Model 2.0 encoding rule. |
XML Schema target |
|||
sqlEncodingRule |
all |
SQL encoding rule to apply. Default is '*'. |
SQL target |
|||
sqlOnDelete |
property, association |
Define the foreign key referential action for the case of a deletion (of the record that is referenced by the foreign key). |
SQL target |
SqlDdl target Foreign Key Referential Actions |
||
sqlOnUpdate |
property, association |
Define the foreign key referential action for the case of an update (of the record that is referenced by the foreign key). |
SQL target |
SqlDdl target Foreign Key Referential Actions |
||
sqlSchema |
package, association |
Provides the name of the database schema to be used when encoding the model elements contained in the package, or the association, to database objects (especially tables). |
SqlDdl target |
|||
sqlUnique |
property |
If set to 'true', then: |
SQL and ArcGIS Workspace targets |
|||
status |
class |
Can be used to prevent loading of classes if input parameter 'prohibitLoadingClassesWithStatusTaggedValue' is set. If the tagged value matches one of the values of this parameter, the class will not be loaded. |
Input parameter prohibitLoadingClassesWithStatusTaggedValue |
|||
suppress |
class |
Used to suppress the creation of object elements, local properties and property types for the class in the XML Schema. |
||||
targetNamespace |
package |
applicationSchema |
ISO 19136 |
The target XML namespace of the application schema. |
||
timeIntervalBoundaryType |
property |
Identifies the type with which the start and end of a temporal property shall be encoded. |
Flattener transformation |
|||
Title |
class |
codeList, enumeration |
Used (as alias for tagged value 'name') in the (old) OWS-8 ontology target to define the skos:prefLabel of skos:ConceptSchemes created for the codelist/enumeration. |
(old) OWS-8 ontology target |
||
toCodelist |
class |
enumeration |
If set to 'false', the enumeration is not converted to a code list by the TypeConverter transformation rule-trf-enumeration-to-codelist. |
TypeConverter transformation |
||
toFeatureType |
class |
Set to 'true', in order for a class being transformed to a feature type by the Type Converter rule-trf-toFeatureType. |
TypeConverter transformation |
|||
unit |
property |
Identifies the fixed unit of measure of the property. |
JSON Schema target |
|||
uomResourceRepresentation |
package |
schema, applicationSchema |
MIME type indicating the units dictionary representation. Currently, only one value is specified: \application/gml+xml;version=3.2\ for a GML dictionary (as currently used in the MDR). |
|||
uomResourceURI |
package |
schema, applicationSchema |
Base URI of the units dictionary Example: http://metadata.ces.mil/mdr/ns/GSIP/uom/\ |
|||
uomResourceValuePattern |
package |
schema, applicationSchema |
Access pattern for the unit, containing the following substitution points: |
|||
validate |
property |
Used in creating an application configuration file (via the as yet undocumented, AppConfiguration target). |
AppConfiguration target (undocumented) |
|||
valueTypeOptions |
class |
OGC UGAS-2020 Engineering Report |
Defines which types are allowed as value type for a given UML property. |
JSON Schema target |
||
version |
package |
applicationSchema |
ISO 19136 |
Current version of the application schema. |
||
vocabulary |
class |
codeList |
INSPIRE |
URI of the vocabulary/code list in a registry. Alias to 'codeList'. |
||
voidReasonType |
property |
Used to indicate which absence reasons apply for a given (typically: voidable) property. The tag value identifies an enumeration that defines the absence reasons. |
TypeConverter transformation |
|||
xmlns |
package |
applicationSchema |
ISO 19136 |
Namespace prefix to be used as short form of the target namespace. |
||
xmlSchemaType |
class |
type |
ISO 19136 |
If the type has a canonical XML Schema encoding the XML Schema typename corresponding to the data type shall be given as the value. |
||
xsdAsAttribute |
property |
If the tagged value asXMLAttribute (or xsdAsAttribute) is set to true on a property, the property has a maximum multiplicity of 1 and the value of the property is simple, the property is converted to an XML attribute instead of an XML element. |
XML Schema target |
|||
xsdDocument |
package |
applicationSchema, no stereotype |
ISO 19136 |
Name of an XML Schema document to create representing the content of the package. |
||
xsdEncodingRule |
all |
XML Schema encoding rule to apply. Default is iso19136_2007. |
1.3. OCL Constraints
In an extension to the standard encoding rules, ShapeChange supports also parsing of OCL constraints in the application schema (not for XMI 1.0 models, as these have no standard mechanism for representing constraints). The supported set of expressions is documented here.
If the UML tool does not support OCL constraints directly, constraints may also be represented in a tagged value "oclExpressions".
1.4. Requirements of the XML Schema output target
All model elements in application schema packages must meet the requirements in this section, if the XML Schema target is used.
1.4.2. Requirements for packages
| Identifier | Descriptions |
|---|---|
req-xsd-pkg-xsdDocument-unique |
All tagged values xsdDocument in a UML model must be unique. |
1.4.3. Requirements for classes
| Identifier | Descriptions |
|---|---|
req-xsd-cls-mixin-supertypes |
Mixin classes must have no instantiable supertypes. |
req-xsd-cls-mixin-supertypes-overrule |
Overrules req-xsd-cls-mixin-supertypes and allows that mixin classes may have supertypes that are not mixin. |
req-xsd-cls-name-unique |
All class names within the same application schema must be unique. |
req-xsd-cls-ncname |
Each class name must be a NCName. |
1.4.4. Requirements for properties
| Identifier | Descriptions |
|---|---|
req-xsd-prop-data-type |
If the value type is data type the property must be an attribute or a composition. |
req-xsd-prop-ncname |
The property name must be a NCName. |
req-xsd-prop-value-type-exists |
The value type shall either be a predefined type or a class defined in the UML model. |
GML requires that a tagged value "sequenceNumber" shall be specified for every attribute. The value shall be an integer and be unique for all attributes and association ends of a class. As the sequenceNumber values are used to organize the properties of a class, this cannot be tested in the validation step, but errors are reported during the initial processing of the model.
ShapeChange supports a more flexible approach for sequenceNumber values than the GML standard:
-
the value may omitted in which case ShapeChange determines its own order;
-
the value may be a structured integer, e.g. values like "4.2.3".
Multiplicities and visibility are also evaluated during the initial model read process and cannot be validated at a later stage. Any errors and warnings are reported while reading the model.
1.5. Additional Requirements
These requirements may be added in encoding rules.
1.5.1. Requirements for all model elements
| Identifier | Descriptions |
|---|---|
req-all-all-documentation |
Name and definition separators ('-- Name --' and '-- Definition --') must be included in the documentation (Source: INSPIRE). |
1.5.2. Requirements for packages
| Identifier | Descriptions |
|---|---|
req-xsd-pkg-namespace-schema-only |
The tagged values targetNamespace and xmlns may only be set if the package is an application schema. |
rec-xsd-pkg-version |
The tagged value version should be set if if the package is an application schema. If the tagged value is missing a default value will be used. |
req-xsd-pkg-dependencies |
All dependencies must be between schema packages (i.e. packages with a targetNamespace). |
req-xsd-pkg-targetNamespace |
The tagged value targetNamespace must be set if the package is an application schema. If the tagged value is missing a default value will be used. |
req-xsd-pkg-xmlns |
The tagged value xmlns must be set if the package is an application schema. |
req-xsd-pkg-xsdDocument |
The tagged value xsdDocument must be set if the package is an application schema. If the tagged value is missing a name will still be constructed from the package name. |
1.5.3. Requirements for classes
| Identifier | Descriptions |
|---|---|
req-xsd-cls-codelist-asDictionary-true |
For code lists the tagged value asDictionary must be 'true' (Source: INSPIRE). |
req-xsd-cls-codelist-extensibility-values |
For code lists the tagged value extensibility must be empty narrower any (Source: INSPIRE). |
req-xsd-cls-codelist-extensibility-vocabulary |
For code lists the tagged value extensibility!=any implies that a vocabulary is provided (Source: INSPIRE). |
req-xsd-cls-codelist-no-supertypes |
Code lists must have no supertypes (Source: INSPIRE?). |
req-xsd-cls-datatype-noPropertyType |
For data types the tagged value noPropertyType must be 'false' (Source: INSPIRE). |
req-xsd-cls-enum-no-supertypes |
Enumerations must have no supertypes (Source: INSPIRE). |
req-xsd-cls-generalization-consistent |
A generalization relationship may be specified only between two classes that are either: both feature types both object types or both data types. |
req-xsd-cls-objecttype-byValuePropertyType |
For types with identity the tagged value byValuePropertyType must be 'false' (Source: INSPIRE). |
req-xsd-cls-objecttype-noPropertyType |
For types with identity the tagged value noPropertyType must be 'false' (Source: INSPIRE). |
req-xsd-cls-suppress-no-properties |
If the tagged value suppress is 'true' the class must have no properties (Source: Metadata profiling). |
req-xsd-cls-suppress-subtype |
If the tagged value suppress is 'true' the class must have no unsuppressed subtype (Source: Metadata profiling). |
req-xsd-cls-suppress-supertype |
If the tagged value suppress is 'true' the class must have an instantiable supertype (Source: Metadata profiling). |